docs(dev-practices): prioritize the five rules in README#42
Merged
Conversation
…ADME Promotes "One session ↔ one repo" to Rule 1 of a numbered five-rule list at the top of the index README. Rules 2–5 (feature branches, sequential cross-repo work, .github read-only during feature work, git status glance before commit) round out the practice with diminishing-returns ordering — Rule 1 alone catches ~90% of the "git problems" the strategic doc was written to address. Longer narrative, three-tier model, filesystem shared-state inventory, guardrails, diagnostic recipes, and escape hatches (git worktree) stay in parallel-multi-repo-git-hygiene.md and are linked from the README under "Going deeper". Also adds the doc-spec-conforming frontmatter the README was missing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The dev-practices README is now front-and-center about what to actually do, in priority order:
main.github/is read-only during feature workgit statusbefore saying "commit"Each rule is a single bolded directive + a one-paragraph "why and how". A reader gets the actionable practice in under a minute of reading.
Longer material — the three-tier model, filesystem shared-state inventory, guardrails, diagnostic recipes, and the
git worktreeescape hatch — stays inparallel-multi-repo-git-hygiene.mdand is linked under a "Going deeper" section. The strategic doc is the why and rationale; the README is the what to do.Also adds the docs-discoverability-spec-conforming frontmatter the README was missing.
Why
PR #41 (the worktrees guide) was closed: worktrees are an escape hatch, not the default. The simpler "one session per repo" rule covers the same key problem with no setup overhead, no naming convention to memorize, no cleanup discipline. This README rewrite makes that explicit.
Test plan
make check-docs-prosepasses (single-file markdown edit).parallel-multi-repo-git-hygiene.mdresolves.docs-discoverability-spec.mdresolves.🤖 Generated with Claude Code